SftTree/OCX 7.0

SftTree.ItemShown Property

Softel vdm, Inc.

Defines whether an item is shown.

Deprecated - Provided for compatibility with earlier versions only - Use Item.Shown instead

Syntax       

Get

VB.NET

Shown = object.get_ItemShown(ByVal ItemIndex As Integer)  As Boolean

VB

Shown = object.ItemShown(ByVal ItemIndex As Long)  As Boolean

C#.NET

bool Shown = object.get_ItemShown(int ItemIndex);

VC++

VARIANT_BOOL Shown = object->ItemShown[long ItemIndex];
VARIANT_BOOL Shown = object->GetItemShown(long ItemIndex);

C

HRESULT object->get_ItemShown(long ItemIndex, VARIANT_BOOL* Shown);

Delphi

Shown := object.ItemShown[ItemIndex : Integer]   : WordBool;

Put

VB.NET

object.set_ItemShown(ByVal ItemIndex As Integer, ByVal Shown As Boolean)

VB

object.ItemShown(ByVal ItemIndex As Long) = Shown  As Boolean

C#.NET

void object.set_ItemShown(int ItemIndex, bool Shown);

VC++

VARIANT_BOOL object->ItemShown[long ItemIndex] = Shown;
void object->PutItemShown(long ItemIndex, VARIANT_BOOL Shown);

C

HRESULT object->put_ItemShown(long ItemIndex, VARIANT_BOOL Shown);

Delphi

object.ItemShown[ItemIndex : Integer] := Shown   : WordBool;

object

A SftTree object.

ItemIndex

The zero-based item index.

Shown

Defines whether an item is shown.

Boolean

Description

True

The item is shown.

False

The item is not shown.

Comments

Deprecated - Provided for compatibility with earlier versions only - Use Item.Shown instead

The ItemShown property defines whether an item is shown.

An item is considered shown (or visible) if its immediate parent item and all its indirect parent items are expanded or if the item doesn't have a parent item.  If a parent item is collapsed, its dependents are considered not shown.

The Item.Shown property is used to determine if an item is currently visible, i.e., its parent items are expanded and visible themselves.  The Item.Shown property does NOT control whether the item is currently in the range of items visible to the user in the tree control's client area.  The Item.MakeVisible method can be used to display an item in the tree control's client area.

By setting the Item.Shown property to True, an item is made visible by expanding all its direct and indirect parent items.  To display the item in the tree control's client area, use the Item.MakeVisible method.

See Also  SftTree Object | Object Hierarchy


Feedback / comments / error reports for this topic
© 2015 - Softel vdm, Inc. - www.softelvdm.com